<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>rect.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">rect.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    A utility class for representing rectangles.
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_math_rect.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">math/rect.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_math_Rect.html">
          goog.math.Rect</a><br/>
        <div class="class-details">Class for representing rectangular regions.</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>


  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.boundingRect"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">boundingRect<span class="args">(<span class="arg">a</span>,&nbsp;<span class="arg">b</span>)</span>
        </span>
        &#8658; <div class="fullType"><span>?</span><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
      </div>


     <div class="entryOverview">
       Returns a new rectangle which completely contains both input rectangles.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">a</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A rectangle.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">b</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A rectangle.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span>?</span><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>&nbsp;
            A new bounding rect, or null if either rect is null.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line306">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.createFromBox"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">createFromBox<span class="args">(<span class="arg">box</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
      </div>


     <div class="entryOverview">
       Creates a new Rect object with the same position and dimensions as a given
Box.  Note that this is only the inverse of toBox if left/top are defined.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">box</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Box.html">goog.math.Box</a></span></div>
        <div class="entryOverview">A box.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>&nbsp;
            A new Rect initialized with the box&#39;s position and size.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line91">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.difference"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">difference<span class="args">(<span class="arg">a</span>,&nbsp;<span class="arg">b</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span>&gt;</div>
      </div>


     <div class="entryOverview">
       Computes the difference regions between two rectangles. The return value is
an array of 0 to 4 rectangles defining the remaining regions of the first
rectangle after the second has been subtracted.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">a</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">b</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span>&gt;</div>&nbsp;
            An array with 0 to 4 rectangles which together define the difference area of rectangle a minus rectangle b.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line227">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.equals"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">equals<span class="args">(<span class="arg">a</span>,&nbsp;<span class="arg">b</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Compares rectangles for equality.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">a</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">b</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            True iff the rectangles have the same left, top, width, and height, or if both are null.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line116">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.intersection"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">intersection<span class="args">(<span class="arg">a</span>,&nbsp;<span class="arg">b</span>)</span>
        </span>
        &#8658; <div class="fullType"><span>?</span><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the intersection of two rectangles. Two rectangles intersect if they
touch at all, for example, two zero width and height rectangles would
intersect if they had the same top and left.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">a</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">b</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span>?</span><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>&nbsp;
            A new intersection rect (even if width and height are 0), or null if there is no intersection.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line164">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.math.Rect.intersects"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.math.Rect.</span><span class="entryName">intersects<span class="args">(<span class="arg">a</span>,&nbsp;<span class="arg">b</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether two rectangles intersect. Two rectangles intersect if they
touch at all, for example, two zero width and height rectangles would
intersect if they had the same top and left.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">a</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">b</span>
        : <div class="fullType"><span class="type"><a href="class_goog_math_Rect.html">goog.math.Rect</a></span></div>
        <div class="entryOverview">A Rectangle.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether a and b intersect.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_math_rect.js.source.html#line192">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory math</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="closure/goog" current="math/rect.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
